[ZEPPELIN-1323] Add contribution guide for Zeppelin documentation #1326
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
CI failure looks unrelated to this change. Looks great to me! |
docs/CONTRIBUTING.md
Outdated
| If you're going to create new pages, there are some spots you need to add the location of the page. | ||
|
|
||
| - **Dropdown menu in navbar**: add your docs location to [_navigation.html](https://github.com/apache/zeppelin/blob/master/docs/_includes/themes/zeppelin/_navigation.html) | ||
| - **Main index**: add your docs below [What is the next?](http://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/#what-is-the-next) section in [index.md](http://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/#what-is-the-next) with short description. No need to do this if the page is for **Interpreters**. |
Member
There was a problem hiding this comment.
should this point to http://zeppelin.apache.org/docs/latest?
Contributor
Author
There was a problem hiding this comment.
@felixcheung Yeah right. Thx for pointing it out!
AhyoungRyu
force-pushed
the
ZEPPELIN-1323
branch
from
281e94e to
2879ada
Compare
Member
|
LGTM |
Contributor
Author
|
Is this good to go now? :) |
Member
|
Merging if there is no more discussion.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR for?
Recently I added auto generated Table of Contents by #1031 and searching feature by #1266. So I wrote some guide to
docs/CONTRIBUTING.mdabout how to use and how they can be applied to docs page. Hope this helps to new Zeppelin (docs) contributors :)What type of PR is it?
Documentation
Todos
docs/README.mdWhat is the Jira issue?
ZEPPELIN-1323
How should this be tested?
Just click
Viewbutton on the top of the file diff :)Screenshots (if appropriate)
Questions: